home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / maximus / scp_v110.zip / SC.DOC < prev    next >
Text File  |  1993-03-08  |  44KB  |  1,138 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                DOX                                         sixxac/CHAT v1.10
  7.  
  8.                ████████████  ████  ███   ███  ███   ███  █████████  ████████
  9.                ███           ████  ███        ███        ██    ███  ██
  10.                ████████████  ████  █████████  █████████  ██    ███  ██
  11.                       ▄▄▄▄▄  ▄▄▄▄        ▄▄▄        ▄▄▄  ▄▄    ▄▄▄  ▄▄
  12.                ████████████  ████  ███   ███  ███   ███  ██    ███  ████████
  13.  
  14.                Christian Zangl                            FidoNode 2:31/21.0
  15.                sysop of sixxac's hideout          bbs phone # +43-4242-57884
  16.  
  17.  
  18.  
  19.  
  20.    ────────────────────────────────────────────────────────────────────
  21.      sixxac/CHAT LEGAL STUFF
  22.    ────────────────────────────────────────────────────────────────────
  23.     
  24.      sixxac/CHAT is SHAREWARE - it is provided as is, with no warranty 
  25.      of any kind, either expressed or implied. sixxac/CHAT is not even 
  26.      guaranteed to occupy disk space ;). You are free to copy and 
  27.      distribute the sixxac/CHAT archive freely, provided no changes or 
  28.      additions are made to the package (except that you may use you 
  29.      favorite package format).
  30.  
  31.      Christian Zangl (me, the author) shall in no event be held liable
  32.      to you or anyone else for any damages of any kind, incidental or 
  33.      consequential, arising from the use or inability to use this
  34.      program.
  35.  
  36.  
  37.      Maximus-CBCS is a Trademark and Copyright by Scott J. Dudley.
  38.  
  39.  
  40.     ──────────────────────────────────────────────────────────────────────
  41.     sixxac/CHAT REGISTRATION
  42.  
  43.      You have to register sixxac/CHAT within a month or stop using it! 
  44.      With the registration of sixxac/CHAT you'll get a REGISTER KEY to 
  45.      enable TTY chat mode, full alias and macro functions (in the 
  46.      unregistered version they are turned off after 15 minutes) and 
  47.      you support me to make future versions.
  48.  
  49.      The registration fee has to be paid in Austrian Schillings (ATS)!
  50.      Its price is 200.-- ATS (about 19.-- US$).
  51.  
  52.      Please print and fill in the registration form, or if it is
  53.      possible, fill in your data with an editor and then print it out.
  54.      The registration form is in the file "REGISTER.DOC" that came with
  55.      this package.
  56.  
  57.      Send the registration form to
  58.  
  59.            Christian Zangl               FidoNet 2:31/21.0
  60.            Franz-Krainer-Str. 42         BBS Phone +43-4242-57884
  61.            9500 Villach
  62.            Austria, Europe
  63.  
  64.      You may also send the registration form by electronic mail to my BBS, 
  65.      but if you do this via FidoNet please CRASH the mail to me - just for 
  66.      security reasons.
  67.  
  68.      There are many ways to send me the money, but don't forget that *you*
  69.      have to pay the *transfer fee*!
  70.  
  71.      Here are some:
  72.  
  73.         o send me a cheque that is drawn on the Austrian bank
  74.           "Bank fuer Kaernten und Steiermark"
  75.  
  76.         o use an international postal money order (ask your local 
  77.           postoffice for more information about that)
  78.  
  79.         o send me a normal cheque
  80.  
  81.         o put the money into an envelope and mail it to me
  82.  
  83.  
  84.    ────────────────────────────────────────────────────────────────────
  85.      sixxac/CHAT MAIN FEATURES
  86.    ────────────────────────────────────────────────────────────────────
  87.  
  88.      o  Chat windows with everythig that is standard (including word
  89.         wrap, cursor keys, ...)
  90.      o  Window size and positions are changeable using the config file 
  91.         or even _while_ chatting (with the mouse).
  92.      o  Fully configurable with more than 60 different configuration 
  93.         keywords (colors, borders, ...).
  94.      o  Scrolling or overwriting mode for chat window (with autodetect
  95.         depending on callers baud rate) and autodetect for the number
  96.         of lines to scroll (but also changeable while chatting).
  97.      o  ANSI to TTY adapter. This enables you to chat (in a
  98.         split screen) to a user that uses only a TTY terminal!
  99.      o  Capture chat to Maximus compatible ASCII logfile (in " FL> text" 
  100.         style like a fido message) and/or to an ANSI logfile.
  101.      o  Support for _unlimited_ aliases and key macros (including a 
  102.         startup macro)! They can be activated for the user, sysop or 
  103.         both. Also several translation characters (user name, time, 
  104.         quotes, remaining time,  ...) are available.
  105.      o  Yell MODE includes events for paging times, length of yelling, 
  106.         what tune to play or if the user may select the tune (from the
  107.         Maximus tunes.bbs file) and converts the tune on the fly to 
  108.         ANSI MUSIC to play it to the user (same tunes can be played
  109.         while chatting!). It's also possible to display your ansi yelling 
  110.         file simultaneously to the yell-countdown.
  111.      o  User settings (for as many users as you wish) and a global setting 
  112.         for all other users to specify the level, number of tunes per 
  113.         day/event, tune and length of yell.
  114.      o  FAST Scroll back - only for the sysop to look what he or the user
  115.         said an hour ago (the user won't notice anything)
  116.      o  Support for LASTUSER.BBS to stop the users time, toggle the nerd 
  117.         flag or exit automaticaly if the users time is up. You can also
  118.         specify what key to set if you did not answer the yell and use 
  119.         MECCA to ask him to leave a comment.
  120.      o  Include other config files depending on the system time. So you
  121.         can use differend colors, window styles, ansi yell files, 
  122.         tune files, quotes, ... at different days or times.
  123.  
  124.  
  125.  
  126.  
  127.    ────────────────────────────────────────────────────────────────────
  128.      sixxac/CHAT versions and operating systems
  129.    ────────────────────────────────────────────────────────────────────
  130.  
  131.      Currently there are three different versions of sixxac/CHAT
  132.      available:
  133.  
  134.      o  OS/2 version  v 1.10.OS2.xx
  135.         This is the most powerfull version yet!
  136.  
  137.      o  OS/2 Multiline version v 1.03.ML2b.xx (beta)
  138.         The beta version was discontinued temporarily.
  139.  
  140.      o  DOS version v 0.04.DOSb.xx (beta)
  141.         This is a quick port of the 1.04.OS2 version to
  142.         DOS. It has not the power nor the speed but works 
  143.         quite well. NOTE: read "READ_DOS.DOC" for more
  144.         information!
  145.  
  146.  
  147.  
  148.    ────────────────────────────────────────────────────────────────────
  149.      sixxac/CHAT SYSTEM REQUIREMENTS
  150.    ────────────────────────────────────────────────────────────────────
  151.  
  152.      o  an IBM (or compatible) personal computer running OS/2
  153.         with some free (virtual) memory
  154.  
  155.      o  IBM-OS/2 version 2.0 or greater
  156.  
  157.      o  some space on your harddisk (about 300kb)
  158.  
  159.      o  a BBS software capable passing the FILE HANDLE of the 
  160.         COMM port to sixxac/CHAT (like Maximus)
  161.  
  162.  
  163.  
  164.  
  165.    ────────────────────────────────────────────────────────────────────
  166.      Quick installation
  167.    ────────────────────────────────────────────────────────────────────
  168.  
  169.         Edit sc.cfg to fit your needs (don't forget to set the
  170.         correct sysop name).
  171.  
  172.         Then make a directory "sc" in your maximus directory. (If your 
  173.         maximus directory is called "d:\max" make "d:\max\sc") and move 
  174.         all files from this package to this directory.
  175.  
  176.  
  177.     ──────────────────────────────────────────────────────────────────────
  178.     MAXIMUS MECCA configuration:
  179.  
  180.         Put this lines into max\MISC\F1.MEC (or any other Fx.MEC you 
  181.         wish to use).
  182.  
  183.         For single line systems (use the sample file F1.MEC in the 
  184.         maxconf.zip archive):
  185.  
  186.           [white]loading sixxac/CHAT
  187.           [Xtern_run]@sc\scp.exe -p%P -csc\sc.cfg -mlastuser.bbs
  188.  
  189.         For multiline systems (use the sample file F2.MEC in the 
  190.         maxconf.zip archive):
  191.  
  192.           [white]loading sixxac/CHAT
  193.           [Xtern_run]@sc\scp.exe -p%P -csc\sc.cfg -x%k -mlastus%K.bbs
  194.  
  195.         then run meccap.exe (that came with Maximus) on this file or just
  196.         use the Fx.BBS file from the maxconf.zip archive. After this you 
  197.         can use the <F1> or <F2> key in Maximus to start a chat with the 
  198.         user (and without entering the yell mode).
  199.  
  200.  
  201.     ──────────────────────────────────────────────────────────────────────
  202.     MAXIMUS Menu configuration:
  203.  
  204.         Add this line to you menus.ctl file (it is located in your 
  205.         Maximus directory):
  206.  
  207.           Display_File    misc\yellsc           Disgrace "Yell for SYSOP"
  208.  
  209.         and and *remove* the old "yell for sysop" Line that may look 
  210.         like this:
  211.  
  212.           Yell                                  Disgrace "Yell for SysOp"
  213.  
  214.         If you forget to remove it the user will yell once with sixxac/CHAT 
  215.         and once with Maximus-yell!
  216.  
  217.  
  218.         Then make a file call yellsc.mec (use "yellsc.mec" from the 
  219.         samples.zip archive) in the max\misc directory that has the following 
  220.         text in it:
  221.  
  222.           [white on black]
  223.           [white]loading sixxac/CHAT
  224.           [Xtern_run]@sc\scp.exe -p%P -csc\sc.cfg -mlastuser.bbs -y
  225.           [cyan on black][ne /Q][quit]
  226.  
  227.           Sorry, the sysop is not available yet!
  228.           Do you wish to leave him a private message? [[y,N] [ansreq menu]yn|
  229.  
  230.           [choice]Y[leave_comment]
  231.  
  232.         If you are multiline just use the file "yellscm.mec" that came in the
  233.         samples.zip archive!        
  234.  
  235.         Now don't forget to make a "siltp max" and run a "meccap misc\yellsc"
  236.         (also included with Maximus)!
  237.  
  238.  
  239.     ──────────────────────────────────────────────────────────────────────
  240.     MAXIMUS CHAT KEY (ALT-C) configuration:
  241.  
  242.         Edit you max.ctl file and change the "Chat External", if you
  243.         have a single line system to:
  244.  
  245.           Chat External sc\scp.exe -p%P -mlastuser.bbs -csc\sc.cfg
  246.         
  247.         For multiline systems use:
  248.  
  249.           Chat External sc\scp.exe -p%P -x%k -mlastus%K.bbs -csc\sc.cfg
  250.  
  251.         and run siltp max!
  252.  
  253.  
  254.  
  255.    ────────────────────────────────────────────────────────────────────
  256.      KEY assingments
  257.    ────────────────────────────────────────────────────────────────────
  258.  
  259.  
  260.     ──────────────────────────────────────────────────────────────────────
  261.     SYSOP KEYS while in MultiLine Server mode:
  262.  
  263.         <SPACE>             LOGON - opens a chat window for the sysop
  264.  
  265.         <ESC>               LOGOFF all users and exit sixxac/CHAT
  266.  
  267.  
  268.     ──────────────────────────────────────────────────────────────────────
  269.     SYSOP KEYS while chatting:
  270.  
  271.         <F1>                toggle the scrolling in the chat window 
  272.                             to overwrite mode
  273.  
  274.         <F2>                turn ascii logfile on/off
  275.  
  276.         <F3>                redraw screen. usefull for noisy 
  277.                             telephone lines.
  278.  
  279.         <F4>                toggle user level. this effects only the
  280.                             users possibility to play ansi music and
  281.                             if you can hear the music.
  282.  
  283.         <F5>                toggle window positions
  284.  
  285.         <F6>                clear all chat windows
  286.  
  287.         <Page Up>           if you are not already in scrollback mode 
  288.                             you would enter it and and scroll up 
  289.                             one page
  290.         <Page Down>         as <Page Up> but scroll down one page
  291.         <Cursor Up>         as <Page Up> but scroll up one line
  292.         <Cursor Down>       as <Page Up> but scroll up one page
  293.  
  294.         <Pos1>              when not in scrollback mode, go to the 
  295.                             beginning of the line, when in scrollback 
  296.                             mode go to the begining of the chat.
  297.  
  298.         <End>               end scrollback mode or if not in scrollback mode
  299.                             go to the end of the line.
  300.  
  301.  
  302.     ──────────────────────────────────────────────────────────────────────
  303.     USER & SYSOP KEYS while chatting:
  304.  
  305.         <CTRL>+<k>          same as <F1>
  306.  
  307.         <CTRL>+<l>          same as <F3>
  308.  
  309.         <CTRL>+<d>          clear your own window
  310.  
  311.  
  312.     ──────────────────────────────────────────────────────────────────────
  313.     SYSOP KEYS while user is yelling or selecting tunes:
  314.  
  315.         <ESC>               abort YELL and drop the user back to where he 
  316.                             came from (bbs).
  317.         <TAB>               abort YELL and display the YELL_NO ansi file
  318.                             defined in the config.
  319.         <SPACE>             turn the sound off. Yelling will continue, but
  320.                             you won't hear anything.
  321.         any other key       (no not the reset key ;) to begin chatting. 
  322.  
  323.  
  324.  
  325.  
  326.  
  327.    ────────────────────────────────────────────────────────────────────
  328.      Mouse support
  329.    ────────────────────────────────────────────────────────────────────
  330.  
  331.  
  332.      
  333.         Klick on the first row of the window to move it.
  334.          
  335.               >> ╒════════[ Christian Zangl ]════════╕ <<
  336.                  │                                   │
  337.                  │                                   │
  338.                  │                                   │
  339.                  │                                   │
  340.                  │                                   │
  341.                  └───────────────────────────────────┘ <
  342.  
  343.         To resize the window click on the lower right edge.
  344.  
  345.         Click into the window to exchange it with another 
  346.         (like drag&drop).
  347.  
  348.  
  349.  
  350.    ────────────────────────────────────────────────────────────────────
  351.      DEFAULT ALIASES
  352.    ────────────────────────────────────────────────────────────────────
  353.  
  354.         They are activated when typed in a chat window - just like 
  355.         normal aliases.
  356.  
  357.  
  358.     ──────────────────────────────────────────────────────────────────────
  359.     SCROLL LINES "/s"
  360.  
  361.         Syntax: /s[line#] 
  362.  
  363.         See the config keyword "SCROLL_LINES" for more information.
  364.  
  365.  
  366.     ──────────────────────────────────────────────────────────────────────
  367.     TUNES & ANSI MUSIC "/t"
  368.  
  369.         sixxac/CHAT is able to convert many tunes to ansi music and
  370.         play them to the user if his terminal software supports ansi
  371.         music! 
  372.  
  373.         At this time I only know that Telemate 3.10 is able to do 
  374.         play music, but the user will automaticaly be showed if he has 
  375.         this support.
  376.  
  377.         Within sixxac/CHAT you've a special feature to play tunes and/or 
  378.         music _while_ chatting! It's used like an alias and has the 
  379.         following syntax:
  380.  
  381.           /t[s|b|u|x][<tune#>]
  382.  
  383.           s: play tune to sysop
  384.           b: play tune to sysop and music to user
  385.           u: play music to user
  386.           x: use last settings
  387.           no option: turn music off
  388.           
  389.         Type these examples while chatting with the user:
  390.  
  391.           /ts36  play tune number 36 to the sysop
  392.           /tb    play last tune/music to both user and sysop
  393.           /tu1   play tune number 1 to the uesr
  394.           /t     turn tune/music off
  395.           /t2    play tune number 2 to user/sysop as specified
  396.                  in the last tune
  397.  
  398.  
  399.         Note: the user has to use a terminal program that supports
  400.               ansi music!
  401.  
  402.  
  403.     ──────────────────────────────────────────────────────────────────────
  404.     WINDOW STYLES "/w"
  405.  
  406.         This allows you to alter your window positions and window sizes.
  407.         It's used like an alias and has the following syntax:
  408.  
  409.           /w{<shift>|#<style><shift>}
  410.  
  411.         <style> may be a number from 0 to 3 with the following meaning:
  412.  
  413.              0: sysop bottom, user top
  414.              1: sysop left,   user right
  415.              2: sysop top,    user bottom
  416.              3: sysop right,  user left
  417.  
  418.         <shift> is the number of lines/chars to make the sysop chat window
  419.         bigger than normal. If you use a number smaller than zero the users 
  420.         window will get bigger.
  421.  
  422.         Examples:
  423.  
  424.          If you want a big window and the user needs only a few lines 
  425.          then type: /w8
  426.  
  427.          To get your window on to right (the users to the left) and
  428.          give him more space to write use: /w#3-10
  429.          (If you need more space use /w#310)
  430.  
  431.  
  432.  
  433.    ────────────────────────────────────────────────────────────────────
  434.      sixxac/CHAT COMMANDLINE USAGE
  435.    ────────────────────────────────────────────────────────────────────
  436.  
  437.         scp   [-pFH] [-bBAUD] [-nUNAME] [-cCNF] [-xNode] [-y] [-gGM]
  438.               [-z] [-sCC] [-mLU]
  439.  
  440.          -p Filehandle: integer string containing the file handle of the 
  441.                         com port (default 0)
  442.  
  443.             sixxac/CHAT must be passed the FILE HANDLE of the opened com
  444.             port from the BBS software (Maximus). Using the sample 
  445.             mecca file (F6.MEC) or the sample menus.ctl line supplied 
  446.             with this document does this properly. DO NOT try to hard 
  447.             code this value. Passing '1' for COM1: will NOT WORK!
  448.  
  449.             All serial port options (bps, parity, handshaking) are
  450.             inherited from the BBS software (Maximus). sixxac/CHAT does 
  451.             not open, close, or alter the comm parameters in any way
  452.             (so there is no support for XON/XOFF flow control)!
  453.  
  454.             If FHANDLE is 0 sixxac/CHAT will use the keyboard instead
  455.             of the modem! This is useful for testing or (when a pipe
  456.             is used) a local chat over the network.
  457.  
  458.  
  459.          -b BAUD: integer string containing the connect speed 
  460.                   (default 9600)
  461.  
  462.             This parameter is only used for automatic selection of
  463.             scrolling or overwriting!
  464.  
  465.  
  466.          -m LASTUSER: name and path to the lastuser.bbs file.
  467.  
  468.             This file is created by Maximus and contains various
  469.             information about the user. 
  470.  
  471.             If you use this switch you should NOT specify the
  472.             -n, -g or -b parameters. 
  473.  
  474.             (if you encounter any problems with the baudrate you
  475.             may aditionally specify the -b parameter!)
  476.  
  477.  
  478.          -n Username: the users first and last name (default User)
  479.  
  480.             Use the underscore '_' instead of a blank ' '!
  481.  
  482.  
  483.          -c CNF: path and name of the config file (default sc.cfg)
  484.  
  485.             This is only needed if the config file is not named 
  486.             sc.cfg or if it is not in the current directory.
  487.  
  488.  
  489.          -x Node: The current nodenumber in a multinode system
  490.  
  491.             This enables the MULTINODE SUPPORT within sixxac/CHAT.
  492.             An extension of ".Lxx" (xx stands for the nodenumber)
  493.             will be added to all logfiles. If you don't have HPFS
  494.             then remove all logfilename extensions (including the 
  495.             '.') from the config file!
  496.  
  497.  
  498.          -y Yelling mode (no default)
  499.  
  500.             This activates check for the yell event and enables music 
  501.             to get the sysop to the computer (check out the configuration
  502.             keywords Y_EVENT, TUNESFILE and YELL_...)
  503.  
  504.  
  505.          -g Grapicsmode (default ansi)
  506.  
  507.             This switch selects weather to use ansi (GM=1) or tty (GM=0) 
  508.             mode for the user. (you should let the bbs pass this 
  509.             parameter (as the user selected it) to sixxac/CHAT - under
  510.             Maximus use -g %g)
  511.  
  512.             To enable tty support you need a REGISTER KEY! Read the 
  513.             registration section about how to get one.
  514.  
  515.             TTY support will in no way alter your display (except for the
  516.             "TTY" on the status line), you are still using the split 
  517.             screen!
  518.  
  519.             The TTY user will have *no* split screen (that is not possible
  520.             in tty mode).
  521.  
  522.             To avoid any "unreadable chats" the <pos1> <end> and cursor 
  523.             keys are disabled. Also if you or the user type something 
  524.             before the other one stops typing or did not press <enter> 
  525.             after he finished - a new line is forced so that everything
  526.             is still readable for both of you.
  527.             
  528.             If you select ansi everything is the same (really nice 
  529.             colorfull split screen) on both sides.
  530.  
  531.  
  532.          -z CLIENTMODE (no default)
  533.  
  534.             start sixxac/CHAT in CLIENT mode - check for a sixxac/CHAT 
  535.             SERVER (if none is found it will start one) and connect to 
  536.             the sixxac/CHAT server via pipe.
  537.             
  538.  
  539.          -s SERVERMODE and Chatchannel (no default)
  540.  
  541.             start sixxac/CHAT in SERVER mode and wait for sixxac/CHAT 
  542.             CLIENTS on chatline CC.
  543.  
  544.  
  545.  
  546.    ────────────────────────────────────────────────────────────────────
  547.      sixxac/CHAT configuration KEYWORDS
  548.    ────────────────────────────────────────────────────────────────────
  549.  
  550.     These are used in the sc.cfg config file. Don't use more than 1000
  551.     characters per line!
  552.  
  553.  
  554.     ALIAS <who> "<word>" "<words>" (no default)
  555.     ──────────────────────────────────────────────────────────────────────
  556.         <who> activates the alias for B (both), U (the user) or S (for the
  557.         sysop). 
  558.  
  559.         An alias is used to change a word to a single word or a whole
  560.         sentence you've specified.
  561.         <word> has to be one single word (no blanks!)
  562.         <words> may contain anything you like, except the " character.
  563.  
  564.         A special alias is named "startup" and will be executed at
  565.         startup. (has to be specified as the first alias!)
  566.  
  567.         There are also some translation characters you may use.
  568.  
  569.           charater(s)    will be replaced by
  570.  
  571.           %|             carriage return.
  572.           %%             % character
  573.           %f             users firstname 
  574.           %l             users lastname 
  575.           %t             current time
  576.           %d             todays date
  577.           %r             remaining minutes in Maximus 
  578.                          (only with the -m switch!)
  579.           %c             chattime
  580.           %q             quote of the day 
  581.                          (you've to use the konfig keyword
  582.                          QUOTEFILE to enable it)
  583.           %b             users baudrate
  584.           %x             In ML mode this will close the users window 
  585.                          and let him return to the bbs.
  586.                          When standalone and REMOTE_EXIT is set to yes 
  587.                          this will end sixxac/CHAT.
  588.  
  589.         You may define as many aliases as you wish, no limit!
  590.  
  591.         some examples:
  592.  
  593.           ALIAS S "startup"   "Hi %f!%|"
  594.           ALIAS B "tschau"    "ciao"
  595.           ALIAS S "cu"        "well, i've to go,%|so ciao!"
  596.           ALIAS B "kb"        "kilobyte"
  597.           ALIAS B "mb"        "megabyte"
  598.           ALIAS U "shit"      "<uff, smells bad in here...>"
  599.           ALIAS B "/first"    "%f"
  600.           ALIAS B "/last"     "%l"
  601.           ALIAS B "/time"     "%t"
  602.           ALIAS B "/date"     "%d"
  603.           ALIAS B "/chattime" "%c"
  604.           ALIAS B "/remain"   "%r"
  605.           ALIAS B "/baud"     "%b"
  606.           ALIAS B "/quit"     "%x"
  607.  
  608.  
  609.     BORDER BOTTOM       "<character>"  (default "─")
  610.     BORDER BOTTOMLEFT   "<character>"  (default "└")
  611.     BORDER BOTTOMRIGHT  "<character>"  (default "┘")
  612.     BORDER LEFT         "<character>"  (default "│")
  613.     BORDER RIGHT        "<character>"  (default "│")
  614.     BORDER TOP          "<character>"  (default "═")
  615.     BORDER TOPLEFT      "<character>"  (default "╒")
  616.     BORDER TOPRIGHT     "<character>"  (default "╕")
  617.     ──────────────────────────────────────────────────────────────────────
  618.         Here you may specify the characters used for the window border.
  619.  
  620.  
  621.     CLOCK <on/off>  (default on)
  622.     ──────────────────────────────────────────────────────────────────────
  623.         Display the time in the header line.
  624.  
  625.  
  626.     COLOR BG   BORDER <bcolor> <bcolor>  (default BLUE BLUE)
  627.     COLOR FONT BORDER <fcolor> <fcolor>  (default WHITE WHITE)
  628.     ──────────────────────────────────────────────────────────────────────
  629.         These set the border colors for the chat window.
  630.  
  631.         FONT stands the color of the characters and BG is the background-
  632.         color.
  633.  
  634.         The first color is used for your window, the second is used
  635.         for the users window.
  636.  
  637.         <fcolor> may be BLACK, RED, GREEN, BROWN, BLUE, MAGENTA, CYAN
  638.         GRAY, DARK_GRAY, LIGHT_RED, LIGHT_GREEN, YELLOW, LIGHT_BLUE,
  639.         LIGHT_MAGENTA, LIGHT_CYAN or WHITE
  640.  
  641.         <bcolor> may be BLACK, RED, GREEN, BROWN, BLUE, MAGENTA, CYAN
  642.         or GRAY
  643.  
  644.  
  645.     COLOR BG   HEADER <bcolor>  (default WHITE)
  646.     COLOR FONT HEADER <fcolor>  (default BLACK)
  647.     ──────────────────────────────────────────────────────────────────────
  648.         This color is used for the window header.
  649.  
  650.  
  651.     COLOR BG   SCROLLBACK <bcolor> <bcolor>  (default BLUE BLUE)
  652.     COLOR FONT SCROLLBACK <fcolor> <fcolor>  (default YELLOW YELLOW)
  653.     ──────────────────────────────────────────────────────────────────────
  654.         If you scrollback the chat it is displayed in this color.
  655.  
  656.  
  657.     COLOR BG   STATUS <bcolor>  (default BLACK)     
  658.     COLOR FONT STATUS <fcolor>  (default WHITE)
  659.     ──────────────────────────────────────────────────────────────────────
  660.         Colors for the status line/screen (that displays if logfile,
  661.         scrolling is on/off).
  662.  
  663.  
  664.     COLOR BG   WINDOW <bcolor> <bcolor>  (default BLUE BLUE)
  665.     COLOR FONT WINDOW <fcolor> <fcolor>  (default WHITE WHITE)
  666.     ──────────────────────────────────────────────────────────────────────
  667.         Colors for the chat window.
  668.  
  669.  
  670.     COLOR BG   YELL <bcolor>  (default BLUE)
  671.     COLOR FONT YELL <fcolor>  (default WHITE)
  672.     ──────────────────────────────────────────────────────────────────────
  673.         Yelling colors (select tune and count down).
  674.  
  675.  
  676.     CONFIG <filename> <day> <start> <end>  (no default)
  677.     ──────────────────────────────────────────────────────────────────────
  678.         Include another config file.
  679.  
  680.         <day> specifies on what day this config should be loaded, it may
  681.         be one of the following: all, mon, tue, wed, thu, fri, sat, sun
  682.         <start> at and after what time load the config (hh:mm)
  683.         <end> at and before what time load the config (hh:mm)
  684.  
  685.         Example: 
  686.  
  687.          You want a different color for the chat windows between 23:00 
  688.          and 8:00 to signal the caller that this is a "special" time to 
  689.          chat with you.
  690.  
  691.          Add this config keywords to sc.cfg:
  692.  
  693.            CONFIG sc1.cfg all 23:00 24:00 ; you have to split it up if it
  694.            CONFIG sc1.cfg all 00:01 08:00 ; passes midnight!
  695.  
  696.          And the sc1.cfg file has to contain something like
  697.  
  698.            COLOR FONT WINDOW BLUE BLUE          
  699.            COLOR BG   WINDOW GRAY GRAY            
  700.            COLOR FONT BORDER BLUE BLUE          
  701.            COLOR BG   BORDER GRAY GRAY            
  702.  
  703.          or any other special config you want.
  704.  
  705.  
  706.     DEFAULT_USER <name>  (default Unknown User)
  707.     ──────────────────────────────────────────────────────────────────────
  708.         The default user name. It will used if the -n parameter is 
  709.         missing. As the sysops name, it is displayed on top of the users
  710.         chat window and the first letter of the firstname and the 
  711.         lastname is used for the logfile.
  712.  
  713.  
  714.     REGISTER_KEY <string>  (no default)
  715.     ──────────────────────────────────────────────────────────────────────
  716.         Your register key. You'll get one if you register sixxac/CHAT!
  717.         This key enables TTY to SPLIT SCREEN chat!
  718.  
  719.  
  720.     LANGUAGE TTY_YELL <string> (no default)
  721.     ──────────────────────────────────────────────────────────────────────
  722.         TTY message when yelling.
  723.  
  724.  
  725.     LANGUAGE TTY_NYET <string> (no default)
  726.     ──────────────────────────────────────────────────────────────────────
  727.         TTY message when SYSOP is not available
  728.  
  729.  
  730.     LANGUAGE TTY_KEY <string> (no default)
  731.     ──────────────────────────────────────────────────────────────────────
  732.         TTY message to press any key to continue.
  733.  
  734.  
  735.     LANGUAGE TTY_NMORE <string> (no default)
  736.     ──────────────────────────────────────────────────────────────────────
  737.         TTY message when no more yellings are allowed
  738.  
  739.  
  740.     LANGUAGE YELL_TUNE1 <string> (no default)
  741.     ──────────────────────────────────────────────────────────────────────
  742.         How to ask the user to play a tune.
  743.  
  744.  
  745.     LANGUAGE YELL_TUNE2 <string> (no default)
  746.     LANGUAGE YELL_TUNE3 <string> (no default)
  747.     LANGUAGE YELL_TUNE4 <string> (no default)
  748.     ──────────────────────────────────────────────────────────────────────
  749.         Tell the user if he can play ANSI MUSIC or not!
  750.  
  751.  
  752.     LOG ANSIAUTO <on/off>  (default off)
  753.     ──────────────────────────────────────────────────────────────────────
  754.         To get an ansi logfile you've to set this to on.
  755.  
  756.  
  757.     LOG ANSIFILE <name>  (no default)
  758.     ──────────────────────────────────────────────────────────────────────
  759.         Sets the path and name to the ansi logfile. This logfile includes
  760.         all ansi sequences. If you use "type <name>" on an os/2 command
  761.         prompt the chat will be displayed to you from the users view.
  762.  
  763.  
  764.     LOG AUTO <on/off>  (default on)
  765.     ──────────────────────────────────────────────────────────────────────
  766.         Turns the logfile on at startup. If you use "off" you've to
  767.         use F2 in sixxac/CHAT to start logging.
  768.  
  769.  
  770.     LOG FILE <name>  (no default)
  771.     ──────────────────────────────────────────────────────────────────────
  772.         Path and name to the logfile. In this logfile all chatting
  773.         is captured in the format " FL> text..." wher 'F' stands for the
  774.         firstname and 'L' for the Lastname.
  775.  
  776.         For example let "Unknown User" talk to "Unknown SYSOP":
  777.  
  778.         ****** BEGIN CHAT on 31-12-92 at 23:59:59 with Unknown User ******
  779.  
  780.          UU> one second to the new year!
  781.          US> now - a HAPPY NEW YEAR!
  782.  
  783.         ****** END CHAT on 01-01-93 at 00:00:01 ******
  784.  
  785.  
  786.     MACRO <who> '<key>' "<words>" (no default)
  787.     MACRO <who> <ascii value> "<words>" (no default)
  788.     ──────────────────────────────────────────────────────────────────────
  789.         <who> activates the macro for B (both), U (the user) or S (for the
  790.         sysop). 
  791.         <key> or <ascii value> specifies the key you want to replace.
  792.         <words> may contain anything you like, except the " character.
  793.         All | will be replaced by carriage returns.
  794.  
  795.         Examples:
  796.  
  797.              MACRO B 'ä' "ae"
  798.              MACRO B 9 "%|* HELP: <CTRL>+<d> clear your window%|" 
  799.  
  800.         (you can find many more in the cfg file)
  801.  
  802.  
  803.     MAX_STOPTIME <on/off>  (default on) 
  804.     ──────────────────────────────────────────────────────────────────────
  805.         Stop the users time when chatting?      FOR REGISTERED USERS ONLY!
  806.  
  807.  
  808.     MULTINODE_PIPE <name>  (default \\pipe\sixx)
  809.     ──────────────────────────────────────────────────────────────────────
  810.         Pipename used in multiline mode. 
  811.  
  812.         Format: \\<server>\pipe\<name>  or   \pipe\<name>
  813.         <name> has to be 4 characters long!
  814.  
  815.         Examples:  \\server\pipe\sixx
  816.                    \pipe\chat
  817.  
  818.         Note: only available in sixxac/CHAT 1.0xML!
  819.  
  820.  
  821.     QUOTE FILE <name>  (no default)
  822.     ──────────────────────────────────────────────────────────────────────
  823.         Name of the quotes.mec file from Maximus. 
  824.         (Format is quote - blank line - quote - blank line - ...)
  825.         Used with the translation character %q.
  826.  
  827.  
  828.     QUOTE NUM <number>  (default -1)
  829.     ──────────────────────────────────────────────────────────────────────
  830.         Sets the number of quotes in your quotes.mec file.
  831.         Use -1 to let sixxac/CHAT count the quotes or (on slower 
  832.         machines) use numquote.exe and set the correct number!
  833.  
  834.  
  835.     REMOTE_EXIT <on/off>  (default off)
  836.     ──────────────────────────────────────────────────────────────────────
  837.         Let the user exit by typing an alias that has the %q in it. 
  838.         It also sets if sixxac/CHAT should exit if the users time limit
  839.         is up! (in Multiline mode it's always on!) 
  840.  
  841.  
  842.     SCROLL ABOVE <baudrate>  (default 9600)
  843.     ──────────────────────────────────────────────────────────────────────
  844.         <baudrate> is the baudrate you wish to use for scrolling chats.
  845.         Under that speed overwriting is used at startup!
  846.  
  847.  
  848.     SCROLL LINES <baudrate> <lines>  (default 0 1)
  849.     ──────────────────────────────────────────────────────────────────────
  850.         Defines how many lines you want to scroll when in scrolling 
  851.         mode.
  852.  
  853.         <baudrate> specifies above what rate to use <lines> for scrolling.
  854.  
  855.         For example:
  856.  
  857.              SCROLL LINES     0 9 ;    0  to  2399 baud use 9 lines
  858.              SCROLL LINES  2400 5 ; 2400  to 14399 baud use 5 lines
  859.              SCROLL LINES 14400 2 ;    above 14400 baud use 2 lines
  860.  
  861.  
  862.     SYSOP <name>  (default SYSOP)
  863.     ──────────────────────────────────────────────────────────────────────
  864.         Your name (if you are the Sysop). It will be displayed on top
  865.         of your chat window. Also the first letter of the firstname and
  866.         the lastname is used for the logfile.
  867.  
  868.  
  869.     USER <1ST> <LAST> [<LEVEL> [<Y/DAY> [<Y/EVT> [<TUNE> [<COUNT>]]]]]
  870.     ──────────────────────────────────────────────────────────────────────
  871.         Used to set Userlevels, yells per day, yells per event, 
  872.         the tune and the countdown.
  873.  
  874.         <1ST> <LAST> aree the users first and last name or "all users" 
  875.         to set a level for all users. "all users" has to be the LAST 
  876.         user definition!
  877.  
  878.         <LEVEL> specifies the users yell-level. You may set it to "TWIT"
  879.         if you want to displey "no yell event" everytime the user tries 
  880.         to yell. "SILENT" appears to the user if he is yelling, but you
  881.         won't hear a tune! "NORMAL" for normal user and "ALLEVENTS" for
  882.         users that may yell anytime (regardless of events).  (default 
  883.         NORMAL)
  884.  
  885.         <Y/DAY> The maximum yells per day. (default 10)
  886.  
  887.         <Y/EVT> The maximum yells per yell-event. (default 3)
  888.  
  889.         <TUNE>  May be the tune number to be played, 0 to let the user
  890.         select a tune or -1 to use the tune set for the active event.
  891.         (default -1)
  892.  
  893.         <COUNT> the start value for the countdown or -1 to use the value
  894.         set for the active event. (default -1)
  895.  
  896.         Example: USER David Lightman  NORMAL 10 4 -1 10
  897.         The user "David Lightman" may yell 10 times a day, 4 times an
  898.         event. The tune will be taken from the active event and his
  899.         countdown will start at a value of 10.
  900.  
  901.         Example: USER all users NORMAL 5 2
  902.         All users may yell 5 times a day, 2 times an event. The tune and
  903.         the countdown start value are taken from the active event.
  904.  
  905.  
  906.     VERSION <number> (no default)
  907.     ──────────────────────────────────────────────────────────────────────
  908.         Version of your config file - set it to the sixxac/CHAT version.
  909.  
  910.  
  911.     WINDOW_STYLE <style> <shift> (default 0 0)
  912.     ──────────────────────────────────────────────────────────────────────
  913.         window <style>:
  914.  
  915.              0: sysop bottom, user top
  916.              1: sysop left,   user right
  917.              2: sysop top,    user bottom
  918.              3: sysop right,  user left
  919.  
  920.         <shift> is the number of lines/chars to make the sysop chat window
  921.         bigger than the user chat window. If you use a number smaller than
  922.         zero the users window will get bigger.
  923.  
  924.  
  925.     YELL ANSIABOVE <number>  (default 9600)
  926.     ──────────────────────────────────────────────────────────────────────
  927.         <number> is the baudrate you wish to use for ansi yelling.
  928.         Under that speed TTY messages are displayed when yelling.!
  929.  
  930.  
  931.     YELL ANSIYELL <name>  (no default)
  932.     ──────────────────────────────────────────────────────────────────────
  933.         Specifies the path and name of the ansi file. It is shown
  934.         when yelling.
  935.  
  936.  
  937.     YELL COUNTER <on/off/s_on>  (default on)
  938.     ──────────────────────────────────────────────────────────────────────
  939.         You can set to display the countdown simultaneously to the
  940.         ansi yell file (s_on), after the ansi yell file (on) or not (off).
  941.  
  942.  
  943.     YELL COUNTERX <x_screen_cordinate>  (default 58)
  944.     YELL COUNTERY <y_screen_cordinate>  (default 15)
  945.     ──────────────────────────────────────────────────────────────────────
  946.         This sets the positon of the count down.
  947.  
  948.  
  949.     YELL DATAFILE <name>  (default sc_user.dat)
  950.     ──────────────────────────────────────────────────────────────────────
  951.         Path and filename where the user yellings are saved.
  952.  
  953.  
  954.     YELL EVENT  <day> <start> <end> <tune#> <countdown> (no default)
  955.     ──────────────────────────────────────────────────────────────────────
  956.         This is used to set a yell event. You may set as many as you
  957.         want!
  958.  
  959.         <day> specifies the day when this event becomes active, it may
  960.         be one of the following: all, mon, tue, wed, thu, fri, sat, sun
  961.         <start> is the time when the event starts (hh:mm)
  962.         <end> is time when the event ends (hh:mm)
  963.         <tune> specifies the tune number in the tunes.bbs file to be 
  964.         played. If you want the user to select the tune use 0!
  965.         <countdown> is the # of seconds for the countdown.
  966.  
  967.         Example: Y_EVENT all 11:00 23:00 0 21
  968.         This will allow the user to select a tune to play between
  969.         11:00 and 23:00 all days of the week. The tune will be
  970.         played for 21 seconds.
  971.  
  972.  
  973.     YELL FLAG <name>  (no default)
  974.     ──────────────────────────────────────────────────────────────────────
  975.         Name of the no-yell flag file. If the file is found no yelling is
  976.         allowed! 
  977.  
  978.  
  979.     YELL KEY <number>  (default 0)
  980.     ──────────────────────────────────────────────────────────────────────
  981.         Here you can specify what key you want to set if the user yells
  982.         and you do not answer. 
  983.  
  984.         You can then use this key within maximus to ask the user if he
  985.         wants to leave a comment or something else (look into the
  986.         configuration section for an example).
  987.  
  988.         If you specify 0 no key will be set!
  989.  
  990.         Key - Value Table:
  991.  
  992.          XWVUTSRQ     6 | PONMLKJI     4 | HGFEDCBA     2 | 87654321     0
  993.         ----------------|----------------|----------------|-----------------
  994.          x         0x80 | x         0x80 | x         0x80 | x         0x80
  995.           x        0x40 |  x        0x40 |  x        0x40 |  x        0x40
  996.            x       0x20 |   x       0x20 |   x       0x20 |   x       0x20
  997.             x      0x10 |    x      0x10 |    x      0x10 |    x      0x10
  998.              x     0x08 |     x     0x08 |     x     0x08 |     x     0x08
  999.               x    0x04 |      x    0x04 |      x    0x04 |      x    0x04
  1000.                x   0x02 |       x   0x02 |       x   0x02 |       x   0x02
  1001.                 x  0x01 |        x  0x01 |        x  0x01 |        x  0x01
  1002.  
  1003.         Search for the key you wish to use. Get the number from the right 
  1004.         column and row. Add the number of zeros given on the top of the 
  1005.         table.
  1006.  
  1007.         Example: Key J - Value in the 2nd column and 7th row (0x02). Now
  1008.                  add the number of zeros given at the top (4) and you get
  1009.                  the number 0x020000 for key J.
  1010.  
  1011.  
  1012.     YELL NOANSWER <name>  (no default)
  1013.     ──────────────────────────────────────────────────────────────────────
  1014.         Specifies the path and name of the ansi file. It is shown
  1015.         when the sysop did not answer the yell.
  1016.  
  1017.  
  1018.     YELL NOMORE <name>  (no default)
  1019.     ──────────────────────────────────────────────────────────────────────
  1020.         Name of the file to show when the number of yells/day or 
  1021.         yells/event exceed the maximum.
  1022.  
  1023.  
  1024.     YELL NOTYET <name>  (no default)
  1025.     ──────────────────────────────────────────────────────────────────────
  1026.         Specifies the path and name of the ansi file. It is shown
  1027.         when yell is not allowed at this time.
  1028.  
  1029.  
  1030.     YELL TUNES <name>  (default tunes.bbs)
  1031.     ──────────────────────────────────────────────────────────────────────
  1032.         This one sets the path and name of the MAXIMUS tunes.bbs file
  1033.  
  1034.  
  1035.  
  1036.  
  1037.  
  1038.    ────────────────────────────────────────────────────────────────────
  1039.      TUNES.BBS file
  1040.    ────────────────────────────────────────────────────────────────────
  1041.  
  1042.         I don't know from where or whom, but I got it a long time ago. 
  1043.         I hope nobody is annoyed if I include it within this package.
  1044.  
  1045.  
  1046.  
  1047.  
  1048.    ────────────────────────────────────────────────────────────────────
  1049.      sc.err file
  1050.    ────────────────────────────────────────────────────────────────────
  1051.  
  1052.         It is created when an error occours, following errors are
  1053.         possible. 
  1054.  
  1055.  
  1056.     internal error <number>
  1057.     ──────────────────────────────────────────────────────────────────────
  1058.         After an internal error sixxac/CHAT cleans up and tries to exit
  1059.         immediately.
  1060.  
  1061.         01,02  could not create thread 
  1062.         03     could not create semaphore
  1063.         04     could not close semaphore
  1064.         05,06  error while writing to the COMM port
  1065.         08,09  error while writing to the PIPE
  1066.         12,13  pipe has gone
  1067.  
  1068.  
  1069.     file is corrupt!
  1070.     ──────────────────────────────────────────────────────────────────────
  1071.         The SCP.EXE file has been damaged by something.
  1072.         Check out for a virus!
  1073.  
  1074.  
  1075.     tunesbbs: <name>
  1076.     ──────────────────────────────────────────────────────────────────────
  1077.         The tunes.bbs file could not be opened.
  1078.  
  1079.  
  1080.     userdata file: <name>
  1081.     ──────────────────────────────────────────────────────────────────────
  1082.         The file to store the user's last yelling information could
  1083.         not be opened or created!
  1084.  
  1085.  
  1086.     config: <string>
  1087.     ──────────────────────────────────────────────────────────────────────
  1088.         A unrecogniced config keyword was found. 
  1089.  
  1090.  
  1091.     carrier drop
  1092.     ──────────────────────────────────────────────────────────────────────
  1093.         The caller dropped carrier and there was no LOGFILE to record
  1094.         this.
  1095.  
  1096.  
  1097.     open configfile: <name>
  1098.     ──────────────────────────────────────────────────────────────────────
  1099.         The configfile could not be opened.
  1100.  
  1101.  
  1102.     malloc: <number>  
  1103.     ──────────────────────────────────────────────────────────────────────
  1104.         out of memory - OS/2 has virtual memory and normaly this errors 
  1105.         should not occur, but just do be shure I included them.
  1106.  
  1107.         01,02,03  no more space for aliases or macros
  1108.         04        no more space for config filenames 
  1109.         05,06     no more space for yell events
  1110.         07,08     no more space for user definitions
  1111.         09,10,11  no more space for scroll back (should never occur)
  1112.  
  1113.  
  1114.  
  1115.  
  1116.    ────────────────────────────────────────────────────────────────────
  1117.      sixxac/CHAT future features
  1118.    ────────────────────────────────────────────────────────────────────
  1119.  
  1120.       o  PM EXTENSION
  1121.       o  PM Log File Reader
  1122.       o  message to sysop (over Network)
  1123.       o  Multiline Support (is in beta yet)
  1124.  
  1125.  
  1126.  
  1127.    ────────────────────────────────────────────────────────────────────
  1128.  
  1129.  
  1130.      Please send any bug reports to my bbs or route via FidoNet. There 
  1131.      you'll also get the newest version of sixxac/CHAT by requesting 
  1132.      "SIXXCHAT"!
  1133.  
  1134.  
  1135.    ────────────────────────────────────────────────────────────────────
  1136.      sixxac/CHAT - end of dox
  1137.    ────────────────────────────────────────────────────────────────────
  1138.